Skip to main content

Stock Journal by Journal Date

Frequency:

Stock journal by journal date request data to be sent on demand.

Expected data:

Returns article warehouse activity that changes article quantities, filtered by journal date.

Hold code changes are reported through the Stock Journal Holds interface and are not part of this response.

Technical:

{journalDate} is in format yyyy-mm-dd and selects the entries by their UTC timestamp, from 00:00:00 to 23:59:59. journal_date in the response is returned in the time zone of the client, so entries close to midnight can be returned under the neighbouring date.


GET https://{url}/v1/journal/stock/{journalDate}​

Retrieve stock journal entries filtered by journal date.

Response Body​

The response contains a data array of journal entry objects.

Top-level response fields:

NameTypeRequiredDescription
successbooleanYesWhether the operation succeeded
messagestringNoError message, if applicable
errorsstring[]NoAdditional error messages, if present
dataarrayYesArray of journal entry objects

Journal entry object (inside data array):

NameTypeRequiredDescription
journal_idintegerYesJournal entry unique identifier
journal_datestringYesJournal entry date and time (in format '2021-03-29T22:21:11')
article_idstringYesArticle unique identifier in ERP
quantity_changenumberYesQuantity change (delta). Positive or negative.
quantity_unit_idstringYesChanged quantity unit of measure
operation_idintegerYesJournal operation identifier: 2 - Receive, 3 - Picking, 5 - Inventory, 7 - Refill split
operationstringYesOperation description
inventory_reason_idintegerNoInventory reason identifier. Additional information for the inventory operation.
inventory_reasonstringNoInventory reason description

Response​

200: OK — Success​

{
"success": true,
"message": null,
"errors": null,
"data": [
{
"journal_id": 263295,
"journal_date": "2021-03-29T22:21:11",
"article_id": "0001",
"quantity_change": -12,
"quantity_unit_id": "PCS",
"operation_id": 3,
"operation": "Picking",
"inventory_reason_id": null,
"inventory_reason": null
},
{
"journal_id": 263296,
"journal_date": "2021-03-29T22:44:43",
"article_id": "0001",
"quantity_change": -24,
"quantity_unit_id": "PCS",
"operation_id": 5,
"operation": "Inventory",
"inventory_reason_id": 31,
"inventory_reason": "Bad quality"
},
{
"journal_id": 263297,
"journal_date": "2021-03-29T23:14:00",
"article_id": "0006",
"quantity_change": 144,
"quantity_unit_id": "PCS",
"operation_id": 2,
"operation": "Receive",
"inventory_reason_id": null,
"inventory_reason": null
}
]
}

400: Bad Request — Error​

{
"success": false,
"message": "Wrong date format: 2021-13-45"
}